Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adds instructions so folks can build the website #363

Merged
merged 4 commits into from
Feb 3, 2025

Conversation

katyhuff
Copy link
Member

Summary of changes

There has not generally been a clear way to build and preview the site on one's own machine. This adds some instructions.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Associated Issues and PRs

This does not solve issue #360, but it was inspired by issue #360.

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

Copy link
Member

@nsryan2 nsryan2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a note here about the dependencies, but otherwise everything LGTM! For consistency, I suggested adding colons to the end of some steps.

@@ -6,4 +6,26 @@ Fuel Cycles group.

## Building This Website

Coming soon...
It should be sufficient to do the following:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Install the build dependencies for the website. These include ruby, jekyll, and jekyll-scholar. Get started [here](https://jekyllrb.com/docs/installation/).

katyhuff and others added 2 commits February 3, 2025 09:34
Co-authored-by: Nathan Ryan <[email protected]>
Co-authored-by: Nathan Ryan <[email protected]>
@katyhuff katyhuff merged commit 430866f into arfc:source Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: completed
Development

Successfully merging this pull request may close these issues.

2 participants